home *** CD-ROM | disk | FTP | other *** search
/ IRIX Base Documentation 2002 November / SGI IRIX Base Documentation 2002 November.iso / usr / share / catman / p_man / cat3n / t_optmgmt.z / t_optmgmt
Encoding:
Text File  |  2002-10-03  |  11.8 KB  |  199 lines

  1.  
  2.  
  3.  
  4. tttt____ooooppppttttmmmmggggmmmmtttt((((3333NNNN))))                                                    tttt____ooooppppttttmmmmggggmmmmtttt((((3333NNNN))))
  5.  
  6.  
  7.  
  8. NNNNAAAAMMMMEEEE
  9.      _tttt______oooo_pppp_tttt_mmmm_gggg_mmmm_tttt - manage options for a transport endpoint
  10.  
  11. SSSSYYYYNNNNOOOOPPPPSSSSIIIISSSS
  12.      _####_iiii_ffff_dddd_eeee_ffff ______XXXX_OOOO_PPPP_EEEE_NNNN______SSSS_OOOO_UUUU_RRRR_CCCC_EEEE
  13.      _####_iiii_nnnn_cccc_llll_uuuu_dddd_eeee _<<<<_xxxx_tttt_iiii_...._hhhh_>>>>
  14.      _####_eeee_llll_ssss_eeee
  15.      _####_iiii_nnnn_cccc_llll_uuuu_dddd_eeee _<<<<_tttt_iiii_uuuu_ssss_eeee_rrrr_...._hhhh_>>>>
  16.      _####_eeee_nnnn_dddd_iiii_ffff
  17.  
  18.      _iiii_nnnn_tttt _tttt______oooo_pppp_tttt_mmmm_gggg_mmmm_tttt _((((_iiii_nnnn_tttt _ffff_dddd_,,,, _ssss_tttt_rrrr_uuuu_cccc_tttt _tttt______oooo_pppp_tttt_mmmm_gggg_mmmm_tttt _****_rrrr_eeee_qqqq_,,,, _ssss_tttt_rrrr_uuuu_cccc_tttt _tttt______oooo_pppp_tttt_mmmm_gggg_mmmm_tttt _****_rrrr_eeee_tttt_))))_;;;;
  19.  
  20. DDDDEEEESSSSCCCCRRRRIIIIPPPPTTTTIIIIOOOONNNN
  21.      The _tttt______oooo_pppp_tttt_mmmm_gggg_mmmm_tttt function enables a transport user to retrieve, verify, or
  22.      negotiate protocol options with the transport provider.  _ffff_dddd identifies a
  23.      bound transport endpoint.
  24.  
  25.      The _rrrr_eeee_qqqq and _rrrr_eeee_tttt arguments point to a _tttt______oooo_pppp_tttt_mmmm_gggg_mmmm_tttt structure containing the
  26.      following members:
  27.  
  28.           _ssss_tttt_rrrr_uuuu_cccc_tttt _nnnn_eeee_tttt_bbbb_uuuu_ffff _oooo_pppp_tttt_;;;;
  29.           _llll_oooo_nnnn_gggg _ffff_llll_aaaa_gggg_ssss_;;;;
  30.  
  31.      The _oooo_pppp_tttt field identifies protocol options and the _ffff_llll_aaaa_gggg_ssss field is used to
  32.      specify the action to take with those options.
  33.  
  34.      The options are represented by a _nnnn_eeee_tttt_bbbb_uuuu_ffff [see _iiii_nnnn_tttt_rrrr_oooo(3N); also for _llll_eeee_nnnn,
  35.      _bbbb_uuuu_ffff, and _mmmm_aaaa_xxxx_llll_eeee_nnnn] structure in a manner similar to the address in _tttt______bbbb_iiii_nnnn_dddd.
  36.      _rrrr_eeee_qqqq is used to request a specific action of the provider and to send
  37.      options to the provider.  _llll_eeee_nnnn specifies the number of bytes in the
  38.      options, _bbbb_uuuu_ffff points to the options buffer, and _mmmm_aaaa_xxxx_llll_eeee_nnnn has no meaning for
  39.      the _rrrr_eeee_qqqq argument.  The transport provider may return options and flag
  40.      values to the user through _rrrr_eeee_tttt.  For _rrrr_eeee_tttt, _mmmm_aaaa_xxxx_llll_eeee_nnnn specifies the maximum
  41.      size of the options buffer and _bbbb_uuuu_ffff points to the buffer where the options
  42.      are to be placed.  On return, _llll_eeee_nnnn specifies the number of bytes of
  43.      options returned.  _mmmm_aaaa_xxxx_llll_eeee_nnnn has no meaning for the _rrrr_eeee_qqqq argument, but must
  44.      be set in the _rrrr_eeee_tttt argument to specify the maximum number of bytes the
  45.      options buffer can hold.  The actual structure and content of the options
  46.      is imposed by the transport provider.
  47.  
  48.      The _ffff_llll_aaaa_gggg_ssss field of _rrrr_eeee_qqqq can specify one of the following actions:
  49.  
  50.      _TTTT______NNNN_EEEE_GGGG_OOOO_TTTT_IIII_AAAA_TTTT_EEEE    This action enables the user to negotiate the values of
  51.                     the options specified in _rrrr_eeee_qqqq with the transport provider.
  52.                     The provider will evaluate the requested options and
  53.                     negotiate the values, returning the negotiated values
  54.                     through _rrrr_eeee_tttt.
  55.  
  56.      _TTTT______CCCC_HHHH_EEEE_CCCC_KKKK        This action enables the user to verify whether the options
  57.                     specified in _rrrr_eeee_qqqq are supported by the transport provider.
  58.                     On return, the _ffff_llll_aaaa_gggg_ssss field of _rrrr_eeee_tttt will have either
  59.                     _TTTT______SSSS_UUUU_CCCC_CCCC_EEEE_SSSS_SSSS or _TTTT______FFFF_AAAA_IIII_LLLL_UUUU_RRRR_EEEE set to indicate to the user whether
  60.  
  61.  
  62.  
  63.                                                                         PPPPaaaaggggeeee 1111
  64.  
  65.  
  66.  
  67.  
  68.  
  69.  
  70. tttt____ooooppppttttmmmmggggmmmmtttt((((3333NNNN))))                                                    tttt____ooooppppttttmmmmggggmmmmtttt((((3333NNNN))))
  71.  
  72.  
  73.  
  74.                     the options are supported.  These flags are only
  75.                     meaningful for the _TTTT______CCCC_HHHH_EEEE_CCCC_KKKK request.
  76.  
  77.      _TTTT______DDDD_EEEE_FFFF_AAAA_UUUU_LLLL_TTTT      This action enables a user to retrieve the default options
  78.                     supported by the transport provider into the _oooo_pppp_tttt field of
  79.                     _rrrr_eeee_tttt.  In _rrrr_eeee_qqqq, the _llll_eeee_nnnn field of _oooo_pppp_tttt must be zero and the
  80.                     _bbbb_uuuu_ffff field may be _NNNN_UUUU_LLLL_LLLL.
  81.  
  82.      _TTTT______CCCC_UUUU_RRRR_RRRR_EEEE_NNNN_TTTT      If ______XXXX_OOOO_PPPP_EEEE_NNNN______SSSS_OOOO_UUUU_RRRR_CCCC_EEEE is defined, then this flag is supported.
  83.                     This action enables the transport user to retrieve the
  84.                     currently effective option values.  The user specifies the
  85.                     options of interest in _rrrr_eeee_qqqq_----_>>>>_oooo_pppp_tttt_...._bbbb_uuuu_ffff.  The option values
  86.                     are irrevelent and will be ignored; it is sufficient to
  87.                     specify the _tttt______oooo_pppp_tttt_hhhh_dddd_rrrr part of an option only.  The
  88.                     currently effective values are then returned in _rrrr_eeee_tttt_----
  89.                     _>>>>_oooo_pppp_tttt_...._bbbb_uuuu_ffff.
  90.  
  91.      If issued as part of the connectionless-mode service, _tttt______oooo_pppp_tttt_mmmm_gggg_mmmm_tttt may block
  92.      due to flow control constraints.  The function will not complete until
  93.      the transport provider has processed all previously sent data units.
  94.  
  95.      This function resides within both the X/Open compliant _llll_iiii_bbbb_xxxx_nnnn_eeee_tttt and the
  96.      SVR4 compliant _llll_iiii_bbbb_nnnn_ssss_llll Network Services libraries.  Network Services
  97.      applications which require X/Open compliance must link-load with _----_llll_xxxx_nnnn_eeee_tttt.
  98.      Network Services applications which require SVR4 compliance must link-
  99.      load with _----_llll_nnnn_ssss_llll.
  100.  
  101.      On failure, _tttt______eeee_rrrr_rrrr_nnnn_oooo may be set to one of the following:
  102.  
  103.      _TTTT_BBBB_AAAA_DDDD_FFFF               The specified file descriptor does not refer to a
  104.                          transport endpoint.
  105.  
  106.      _TTTT_OOOO_UUUU_TTTT_SSSS_TTTT_AAAA_TTTT_EEEE           The function was issued in the wrong sequence.
  107.  
  108.      _TTTT_AAAA_CCCC_CCCC_EEEE_SSSS              The user does not have permission to negotiate the
  109.                          specified options.
  110.  
  111.      _TTTT_BBBB_AAAA_DDDD_OOOO_PPPP_TTTT             The specified protocol options were in an incorrect
  112.                          format or contained illegal information.
  113.  
  114.      _TTTT_BBBB_AAAA_DDDD_FFFF_LLLL_AAAA_GGGG            An invalid flag was specified.
  115.  
  116.      _TTTT_BBBB_UUUU_FFFF_OOOO_VVVV_FFFF_LLLL_WWWW           There are two different conditions in which _TTTT_BBBB_UUUU_FFFF_OOOO_VVVV_FFFF_LLLL_WWWW
  117.                          will be returned.  If ______XXXX_OOOO_PPPP_EEEE_NNNN______SSSS_OOOO_UUUU_RRRR_CCCC_EEEE is defined _aaaa_nnnn_dddd
  118.                          the number of bytes allocated for incoming data is
  119.                          _gggg_rrrr_eeee_aaaa_tttt_eeee_rrrr _tttt_hhhh_aaaa_nnnn _zzzz_eeee_rrrr_oooo _aaaa_nnnn_dddd is not sufficient to store the
  120.                          data.  If ______XXXX_OOOO_PPPP_EEEE_NNNN______SSSS_OOOO_UUUU_RRRR_CCCC_EEEE is _nnnn_oooo_tttt defined and the number
  121.                          of bytes allocated for incoming data is not
  122.                          sufficient to store the data.  The information to be
  123.                          returned in _rrrr_eeee_tttt will be discarded.
  124.  
  125.  
  126.  
  127.  
  128.  
  129.                                                                         PPPPaaaaggggeeee 2222
  130.  
  131.  
  132.  
  133.  
  134.  
  135.  
  136. tttt____ooooppppttttmmmmggggmmmmtttt((((3333NNNN))))                                                    tttt____ooooppppttttmmmmggggmmmmtttt((((3333NNNN))))
  137.  
  138.  
  139.  
  140.      _TTTT_SSSS_YYYY_SSSS_EEEE_RRRR_RRRR             A system error has occurred during execution of this
  141.                          function.
  142.  
  143. SSSSEEEEEEEE AAAALLLLSSSSOOOO
  144.      _iiii_nnnn_tttt_rrrr_oooo(3N), _tttt______aaaa_cccc_cccc_eeee_pppp_tttt(3N), _tttt______aaaa_llll_llll_oooo_cccc(3N), _tttt______cccc_oooo_nnnn_nnnn_eeee_cccc_tttt(3N), _tttt______gggg_eeee_tttt_iiii_nnnn_ffff_oooo(3N),
  145.      _tttt______llll_iiii_ssss_tttt_eeee_nnnn(3N), _tttt______oooo_pppp_eeee_nnnn(3N), _tttt______rrrr_cccc_vvvv_cccc_oooo_nnnn_nnnn_eeee_cccc_tttt(3N)
  146.  
  147. DDDDIIIIAAAAGGGGNNNNOOOOSSSSTTTTIIIICCCCSSSS
  148.      _tttt______oooo_pppp_tttt_mmmm_gggg_mmmm_tttt returns 0 on success and -1 on failure and _tttt______eeee_rrrr_rrrr_nnnn_oooo is set to
  149.      indicate the error.
  150.  
  151.  
  152.  
  153.  
  154.  
  155.  
  156.  
  157.  
  158.  
  159.  
  160.  
  161.  
  162.  
  163.  
  164.  
  165.  
  166.  
  167.  
  168.  
  169.  
  170.  
  171.  
  172.  
  173.  
  174.  
  175.  
  176.  
  177.  
  178.  
  179.  
  180.  
  181.  
  182.  
  183.  
  184.  
  185.  
  186.  
  187.  
  188.  
  189.  
  190.  
  191.  
  192.  
  193.  
  194.  
  195.                                                                         PPPPaaaaggggeeee 3333
  196.  
  197.  
  198.  
  199.